Instalacja
Wymagania wstępne
- Python 3.9+
Windows
Zainstaluj Pythona i dodaj go do zmiennej PATH.
Linux
Zainstaluj Pythona i dodaj go do zmiennej PATH.
Instalacja CGC za pomocą pip
CLI CGC jest dostępny jako pakiet pip.
$ pip install cgcsdk
PS D:\cgc-docs> pip install cgcsdk
Collecting cgcsdk
Downloading cgcsdk-0.1.1-py3-none-any.whl (31 kB)
...
Installing collected packages: cgcsdk
WARNING: The script cgc.exe is installed in 'C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed cgcsdk-0.1.1
Proszę zwrócić uwagę na komunikat na końcu procesu instalacji.
WARNING: The script cgc.exe is installed in 'C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts' which is not on PATH.
W takim przypadku proszę postępować zgodnie z instrukcją, jak dodać lokalizację do zmiennej PATH.
przykład dla powershell:
$env:Path += ';C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts'
Pakiet tworzy katalog o nazwie cgcsdk w katalogu %%APP_DATA%% lub $HOME. Ten katalog będzie zawierał plik konfiguracyjny po ukończeniu kolejnego kroku.
CGC Tab Completion
Ten krok jest opcjonalny, ale znacznie ułatwi Ci życie, dlatego zalecamy go wykonać.
- Bash
- Zsh
mkdir -p ~/.local/share/bash-completion/completions
_CGC_COMPLETE=bash_source cgc > ~/.local/share/bash-completion/completions/cgc
mkdir -p ~/.local/share/zsh/completions/
_CGC_COMPLETE=zsh_source cgc > ~/.local/share/zsh/completions/_cgc
Teraz dodaj następujące do swojego pliku ~/.zshrc:
fpath=(~/.local/share/zsh/completions $fpath)
autoload -Uz compinit
compinit
Zrobione! Włącz ponownie terminal i możesz używać tab completion. Aby go przetestować, wpisz cgc i naciśnij tab.
Rejestracja w CGC
Aby zalogować się do CLI CGC, należy użyć danych dostarczonych w powitalnym e-mailu. Wpisz:
$ cgc register
Następnie będziesz musiał wprowadzić swoje ID użytkownika oraz klucz dostępu
$ cgc register
User id: <user-id>
Access key: <access-key>
Register successful! You can now use the CLI. Config file saved in <path_to_config_file>